home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 018a / macade.zip / OVERVIEW.DOC < prev    next >
Text File  |  1991-12-07  |  7KB  |  158 lines
  1.  
  2.                  MacroAde (TM)
  3.               Utilities for WordPerfect 5.1 Macros
  4.  
  5.                                   Version 4.2
  6.  
  7.  
  8.                   A Product of
  9.                Performance Sciences International
  10.                 Summerfield, NC
  11.  
  12.           Copyright (c) 1991 by Jeffrey S. Kane, Ph.D.
  13.  
  14.  
  15.                 AN OVERVIEW OF MacroAde
  16.  
  17.      MacroAde is a small but (in our view) highly useful collection
  18. of utilities and macros for proficient users of WordPerfect 5.1. 
  19. The items contained in this package are listed below along with
  20. brief descriptions of each.  Some of the macros, particularly ALTM and
  21. and possibly ALTL, will not work with releases of WordPerfect 5.1 dated
  22. earlier than 12/31/90.  The release date should not be a problem with
  23. any of the utility programs, however.
  24.  
  25. PLEASE NOTE: In the documentation (i.e., .doc) files accompanying each of
  26. the programs in this package, reference is occasionally made to a WordPerfect
  27. command sequence.  A command sequence is a series of keypresses, such as:
  28. SHIFT-F8  2  1.  In order to delimit the end of one keypress and the beginning
  29. of another in such a sequence we have used ASCII character #07, which appears
  30. as follows: .  Thus, the previous command sequence would appear in the
  31. documentation as SHIFT-F8  2  1.  We used this character because it is not
  32. generated by any command key within WordPerfect, leading us to believe that
  33. users would readily realize that it is not part of the command sequence and
  34. that no attempt to enter it should be made.  We have, however, received
  35. questions about what it's supposed to mean, hence this explanation.
  36.  
  37.      Utilities:
  38.  
  39.           The following utilities give users the ability to apply
  40.      the full power of their stand-alone text editors (e.g., QEDIT,
  41.      MultiEdit, VEDIT, Norton Editor) to the creation and
  42.      modification of macros, thereby circumventing the very
  43.      primitive macro editing capability within WordPerfect.  In addition,
  44.      TildeChk will enable you to quickly find and correct the MOST COMMON
  45.      macro programming errors: missing tildes.
  46.  
  47.      1.   MACROLST.exe:   translates WordPerfect 5.1 macro (.wpm)
  48.                           files into corresponding ASCII text files
  49.                           with .LST extensions;
  50.  
  51.      2.   MCOMPILE.exe:   compiles macro source files in ASCII text
  52.                           form into .wpm files executable as macros
  53.               within WordPerfect 5.1;
  54.  
  55.      3.   COMMANDS.ref:   an ASCII text listing of keystroke and
  56.                           macro commands used in WordPerfect 5.1. 
  57.                           It also contains all of the information
  58.                           on the numeric codes for each keystroke
  59.                           command contained in the recently
  60.                           released Appendix T.  This file can be
  61.                           displayed as a second window in any
  62.                           multiwindow editor for reference purposes
  63.               during macro editing; and
  64.  
  65.      4.   TildeChk.exe:   Checks for missing tildes (~) in macro source
  66.               files conforming to the format used by the
  67.               MacroLst decompiler (above).    Produces a listing
  68.               of the line numbers and initial macro commands of
  69.               the sequences in which tildes are missing; reports
  70.               this information for the first 20 tilde omissions
  71.               found.  Missing tildes are the MOST COMMON macro
  72.               programming error.  TildeChk will save you hours
  73.               of time!
  74.  
  75. Macros:
  76.  
  77.      Four unrelated categories of macros are provided in this
  78. package.  The macros in each of the categories are briefly
  79. described below:
  80.  
  81.      1.   Editor Control Macros:
  82.            Each of these macros work in conjunction with a
  83.       batch file, MacroLst, and MCompile to enable you to
  84.       use either any external editor of your choice or
  85.       WordPerfect itself to edit macros.
  86.  
  87.       A.  EDITM.wpm:
  88.             Enables you to use any external editor of your
  89.           choice to edit a macro within a DOS shell and then
  90.           return back to the place you left from in WordPerfect.
  91.           It automatically recompiles the modified macro so it
  92.           is available for use upon your return to WordPerfect.
  93.  
  94.       B.  EDITWP.wpm:
  95.             Converts macros to WordPerfect documents and
  96.           brings them up on the full WordPerfect document screen
  97.           for editing; pressing EXIT causes the edited macro
  98.           to be recompiled, ready for use.
  99.  
  100.      2.   Macro Menu Macros:
  101.                As you utilize the power of macros to a
  102.           progressively greater extent, you inevitably reach the
  103.           point where you can't remember the names and functions of
  104.           all the macros you've defined.  The following macros
  105.           solve this problem by providing the capability to display
  106.           lists of your macros, with descriptions, and to execute
  107.           any one of them by highlighting it and pressing a
  108.           specified key.
  109.  
  110.       A.  ALTM.wpm:
  111.             A relatively simple macro menuing system that
  112.               uses the list files feature of WordPerfect.  Requires
  113.               the 12/31/90 release (or later) of WordPerfect 5.1.
  114.  
  115.       B.  ALTL.wpm:
  116.             A much more sophisticated macromenuing system
  117.           allowing the use of multiple customizable menu
  118.           files and the display of macro names and their
  119.           descriptions on the same screen.    The items in a
  120.           macro menu may be modified or deleted right from
  121.               within the macro menu itself.  Use of this program
  122.               with releases of WordPerfect 5.1 dated prior to
  123.               12/31/90 may encounter some problems, although
  124.               we have not yet been able to confirm them.
  125.  
  126.       C.  MOVECSR.wpm:
  127.             Not a macro menu but a useful adjunct to those
  128.           above.  This macro directs you to move the cursor
  129.           to the place in your document where you want the
  130.           macro you've selected to actually execute.  The
  131.           command to execute this macro is placed at the very
  132.           top of any macro for which you want to be sure the
  133.           cursor is positioned correctly.
  134.  
  135.      3.   BRINGBAK.wpm:  
  136.                A really unique macro that works in combination with
  137.       either of two .exe files to allow you to communicate
  138.           information from an outside program (accessed via SHELL)
  139.           back into WordPerfect.  This capability creates many
  140.           interesting possibilities for shelling out to DOS,
  141.           generating data files via another program or using
  142.           external programs to locate files, and returning to
  143.           WordPerfect with the information that could allow the new
  144.           or located files to be imported.
  145.  
  146.      4.   "On Beyond Z" with ALTZ.wpm:
  147.            Have you run out of letters to use with ALT-invoked macros
  148.       yet?    I had, so I wrote an embarrassingly simple macro which
  149.       allows the use of ALT Z plus any one of up to 54 other characters
  150.       that can be entered from the keyboard that are legal in file
  151.       names.  Undoubtedly, many others have come up with the same
  152.           macro (although a version of the same macro appeared for what was
  153.           apparently the first time in WordPerfect Magazine's October 1991
  154.           issue), but if its availability here helps a few more people,
  155.       it's worth the redundancy.
  156.  
  157.  
  158.